kotlin-stdlib/kotlin.collections/[JS]Iterator

Iterator

interface Iterator<out T>

An iterator over a collection or another entity that can be represented as a sequence of elements. Allows to sequentially access the elements.

Functions

hasNext

abstract operator fun hasNext(): Boolean

Returns true if the iteration has more elements.

abstract operator fun next(): T

Returns the next element in the iteration.

Inheritors

UByteIterator

UShortIterator

UIntIterator

ULongIterator

AbstractIterator

MutableIterator

ListIterator

ByteIterator

CharIterator

ShortIterator

IntIterator

LongIterator

FloatIterator

DoubleIterator

BooleanIterator

Extensions

asSequence

fun <T> Iterator<T>.asSequence(): Sequence<T>

Creates a sequence that returns all elements from this iterator. The sequence is constrained to be iterated only once.

forEach

inline fun <T> Iterator<T>.forEach(operation: (T) -> Unit)

Performs the given operation on each element of this Iterator.

iterator

inline operator fun <T> Iterator<T>.iterator(): Iterator<T>

Returns the given iterator itself. This allows to use an instance of iterator in a for loop.

withIndex

fun <T> Iterator<T>.withIndex(): Iterator<IndexedValue<T>>

Returns an Iterator that wraps each element produced by the original iterator into an IndexedValue containing the index of that element and the element itself.